Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
CAsaNetworkObject Class Reference

CAsaNetworkObject is the asa network object. More...

Public Member Functions

void setHostIp (ip)
 set the host ip address to the asa network object More...
 
ip getHostIp ()
 Returns the host ip address/network address that is set to the asa network object. More...
 
ip getHostMask ()
 Returns the subnet mask that is set to the asa network object. More...
 
ip getInvHostMask ()
 Returns the inverse subnet mask that is set to the asa network object. More...
 
bool removeHostIp (ip)
 Remove the host ip address that is set to the asa network object. More...
 
void setSubnet (ip, ip)
 Set the subnet/mask to the asa network object. More...
 
bool removeSubnet (ip, ip)
 Remove the subnet/mask that is set to the asa network object. More...
 
NatEntry getNatEntry ()
 Returns static nat entry that is set to the asa network object. More...
 
void deleteNatEntry ()
 Remove static nat entry that is set to the asa network object. More...
 
NatListInterface getNatList ()
 Returns dynamic nat entry that is set to the asa network object. More...
 
void deleteNatList ()
 Remove dynamic nat entry that is set to the asa network object. More...
 
void nameifChanged (string, string)
 Remove nat entry when the referenced nameif is changed. More...
 
vector< string > getRunningConfig ()
 Returns all object configuration strings in show run. More...
 
vector< string > getNatRunningConfig ()
 Returns object + nat configuration strings in show run. More...
 
string getNatStatement ()
 Returns the nat statement configuration string in show run. More...
 
string getAddressStatement ()
 Returns the host address/subnet mask statement configuration string in show run. More...
 
void updateAsaAclStatement ()
 Update the corresponding acl statements that have reference to this asa network object. More...
 

Detailed Description

CAsaNetworkObject is the asa network object.

Member Function Documentation

◆ deleteNatEntry()

void CAsaNetworkObject::deleteNatEntry ( )

Remove static nat entry that is set to the asa network object.

◆ deleteNatList()

void CAsaNetworkObject::deleteNatList ( )

Remove dynamic nat entry that is set to the asa network object.

◆ getAddressStatement()

string CAsaNetworkObject::getAddressStatement ( )

Returns the host address/subnet mask statement configuration string in show run.

Returns
string, value is the host address/subnet mask statement configuration string in show run.

◆ getHostIp()

ip CAsaNetworkObject::getHostIp ( )

Returns the host ip address/network address that is set to the asa network object.

Returns
ip, value is the host ip address/network address that is set to the asa network object.

◆ getHostMask()

ip CAsaNetworkObject::getHostMask ( )

Returns the subnet mask that is set to the asa network object.

Returns
ip, value is the the subnet mask that is set to the asa network object.

◆ getInvHostMask()

ip CAsaNetworkObject::getInvHostMask ( )

Returns the inverse subnet mask that is set to the asa network object.

Returns
ip, value is the the inverse subnet mask that is set to the asa network object.

◆ getNatEntry()

NatEntry CAsaNetworkObject::getNatEntry ( )

Returns static nat entry that is set to the asa network object.

Returns
NatEntry, value is the static nat entry.

◆ getNatList()

NatListInterface CAsaNetworkObject::getNatList ( )

Returns dynamic nat entry that is set to the asa network object.

Returns
NatListInterface, value is the nat list interface.

◆ getNatRunningConfig()

vector< string > CAsaNetworkObject::getNatRunningConfig ( )

Returns object + nat configuration strings in show run.

Returns
vector<string>, value object + nat configuration strings in show run

◆ getNatStatement()

string CAsaNetworkObject::getNatStatement ( )

Returns the nat statement configuration string in show run.

return string, value is the nat statement configuration string in show run.

◆ getRunningConfig()

vector< string > CAsaNetworkObject::getRunningConfig ( )

Returns all object configuration strings in show run.

Returns
vector<string>, value is all object configuration strings in show run.

◆ nameifChanged()

void CAsaNetworkObject::nameifChanged ( string  ,
string   
)

Remove nat entry when the referenced nameif is changed.

Parameters
newName,newnameif
oldName,oldnameif

◆ removeHostIp()

bool CAsaNetworkObject::removeHostIp ( ip  )

Remove the host ip address that is set to the asa network object.

Parameters
hostIp,hosip address to remove.
Returns
bool, value is true if the host was removed, false if not.

◆ removeSubnet()

bool CAsaNetworkObject::removeSubnet ( ip  ,
ip   
)

Remove the subnet/mask that is set to the asa network object.

Parameters
hostIp,Hostip address to remove for.
hostMask,Hostmask to remove for.
Returns
bool, return is true if the subnet was removed, false if not.

◆ setHostIp()

void CAsaNetworkObject::setHostIp ( ip  )

set the host ip address to the asa network object

Parameters
hostIp,ipaddress to use as the host.

◆ setSubnet()

void CAsaNetworkObject::setSubnet ( ip  ,
ip   
)

Set the subnet/mask to the asa network object.

Parameters
hostIp,Hostip address to set with.
hostMask,Hostmask to set with.

◆ updateAsaAclStatement()

void CAsaNetworkObject::updateAsaAclStatement ( )

Update the corresponding acl statements that have reference to this asa network object.


The documentation for this class was generated from the following file: